<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="checks_v1alpha.html">Checks API</a> . <a href="checks_v1alpha.accounts.html">accounts</a> . <a href="checks_v1alpha.accounts.repos.html">repos</a> . <a href="checks_v1alpha.accounts.repos.scans.html">scans</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists repo scans for the specified repo.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code>
  <pre>Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.

Args:
  parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for RepoScanService.GenerateScan.
  &quot;cliAnalysis&quot;: { # The results of a Code Compliance CLI analysis. # Required. CLI analysis results.
    &quot;codeScans&quot;: [ # Optional. Requested code scans resulting from preliminary CLI analysis.
      { # A requested analysis of source code. Contains the source code and processing state.
        &quot;dataTypeClassifications&quot;: [ # Optional. Data type classification requests.
          { # A request to classify data types.
            &quot;dataType&quot;: &quot;A String&quot;, # Required. Candidate data type.
            &quot;lineNumber&quot;: 42, # Required. Line number (1-based).
          },
        ],
        &quot;sourceCode&quot;: { # Contains source code from a repo. # Required. Source code to analyze.
          &quot;code&quot;: &quot;A String&quot;, # Required. Source code.
          &quot;endLine&quot;: 42, # Required. End line number (1-based).
          &quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
          &quot;startLine&quot;: 42, # Required. Start line number (1-based).
        },
      },
    ],
    &quot;sources&quot;: [ # Optional. Data sources detected in the scan.
      { # Represents a data source finding.
        &quot;codeAttribution&quot;: { # Source code attribution. # Optional. Source code attribution for the finding.
          &quot;codeExcerpt&quot;: &quot;A String&quot;, # Optional. Code excerpt where the source was detected along with surrounding code.
          &quot;lineNumber&quot;: 42, # Required. Line number (1-based).
          &quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
          &quot;startLineNumber&quot;: 42, # Optional. Start line number of the code excerpt (1-based).
        },
        &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type.
        &quot;falsePositive&quot;: True or False, # Optional. Whether the finding was marked as a false positive.
      },
    ],
  },
  &quot;cliVersion&quot;: &quot;A String&quot;, # Required. CLI version.
  &quot;localScanPath&quot;: &quot;A String&quot;, # Required. Local scan path.
  &quot;scmMetadata&quot;: { # SCM metadata. # Required. SCM metadata.
    &quot;branch&quot;: &quot;A String&quot;, # Required. Branch name.
    &quot;pullRequest&quot;: { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
      &quot;baseBranch&quot;: &quot;A String&quot;, # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
      &quot;prNumber&quot;: &quot;A String&quot;, # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
    },
    &quot;remoteUri&quot;: &quot;A String&quot;, # Required. Git remote URL.
    &quot;revisionId&quot;: &quot;A String&quot;, # Required. Revision ID, e.g. Git commit hash.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.

Args:
  name: string, Required. Resource name of the repo scan. Example: `accounts/123/repos/456/scans/789` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Repo scan.
  &quot;cliVersion&quot;: &quot;A String&quot;, # CLI version.
  &quot;localScanPath&quot;: &quot;A String&quot;, # Local scan path.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the scan.
  &quot;resultsUri&quot;: &quot;A String&quot;, # A URL to view results.
  &quot;scmMetadata&quot;: { # SCM metadata. # SCM metadata.
    &quot;branch&quot;: &quot;A String&quot;, # Required. Branch name.
    &quot;pullRequest&quot;: { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
      &quot;baseBranch&quot;: &quot;A String&quot;, # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
      &quot;prNumber&quot;: &quot;A String&quot;, # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
    },
    &quot;remoteUri&quot;: &quot;A String&quot;, # Required. Git remote URL.
    &quot;revisionId&quot;: &quot;A String&quot;, # Required. Revision ID, e.g. Git commit hash.
  },
  &quot;sources&quot;: [ # Data sources detected.
    { # Represents a data source finding.
      &quot;codeAttribution&quot;: { # Source code attribution. # Optional. Source code attribution for the finding.
        &quot;codeExcerpt&quot;: &quot;A String&quot;, # Optional. Code excerpt where the source was detected along with surrounding code.
        &quot;lineNumber&quot;: 42, # Required. Line number (1-based).
        &quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
        &quot;startLineNumber&quot;: 42, # Optional. Start line number of the code excerpt (1-based).
      },
      &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type.
      &quot;falsePositive&quot;: True or False, # Optional. Whether the finding was marked as a false positive.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists repo scans for the specified repo.

Args:
  parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
  filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter repo scans. Example: `scmMetadata.branch = main`
  pageSize: integer, Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50.
  pageToken: string, Optional. A page token received from a previous `ListRepoScans` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepoScans` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for RepoScanService.ListRepoScans.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;repoScans&quot;: [ # The repo scans for the specified app.
    { # Repo scan.
      &quot;cliVersion&quot;: &quot;A String&quot;, # CLI version.
      &quot;localScanPath&quot;: &quot;A String&quot;, # Local scan path.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the scan.
      &quot;resultsUri&quot;: &quot;A String&quot;, # A URL to view results.
      &quot;scmMetadata&quot;: { # SCM metadata. # SCM metadata.
        &quot;branch&quot;: &quot;A String&quot;, # Required. Branch name.
        &quot;pullRequest&quot;: { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
          &quot;baseBranch&quot;: &quot;A String&quot;, # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
          &quot;prNumber&quot;: &quot;A String&quot;, # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
        },
        &quot;remoteUri&quot;: &quot;A String&quot;, # Required. Git remote URL.
        &quot;revisionId&quot;: &quot;A String&quot;, # Required. Revision ID, e.g. Git commit hash.
      },
      &quot;sources&quot;: [ # Data sources detected.
        { # Represents a data source finding.
          &quot;codeAttribution&quot;: { # Source code attribution. # Optional. Source code attribution for the finding.
            &quot;codeExcerpt&quot;: &quot;A String&quot;, # Optional. Code excerpt where the source was detected along with surrounding code.
            &quot;lineNumber&quot;: 42, # Required. Line number (1-based).
            &quot;path&quot;: &quot;A String&quot;, # Required. Path of the file.
            &quot;startLineNumber&quot;: 42, # Optional. Start line number of the code excerpt (1-based).
          },
          &quot;dataType&quot;: &quot;A String&quot;, # Required. Data type.
          &quot;falsePositive&quot;: True or False, # Optional. Whether the finding was marked as a false positive.
        },
      ],
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>